Class TXLSFormattedObj

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TXLSFormattedObj = class(TObject)

Description

Hierarchy

  • TObject
  • TXLSFormattedObj

Overview

Methods

Public constructor Create(AStyles: TXc12DataStyleSheet);
Public destructor Destroy; override;
Public procedure SetDefaultFormat;
Public procedure CopyToTFont(Font: TFont);
Public function IsFormatted: boolean;

Properties

Public property Protection: TXc12CellProtections read GetProtection write SetProtection;
Public property HorizAlignment: TXc12HorizAlignment read GetHorizAlignment write SetHorizAlignment;
Public property VertAlignment: TXc12VertAlignment read GetVertAlignment write SetVertAlignment;
Public property Indent: integer read GetIndent write SetIndent;
Public property Rotation: integer read GetRotation write SetRotation;
Public property WrapText: boolean read GetWrapText write SetWrapText;
Public property ShrinkToFit: boolean read GetShrinkToFit write SetShrinkToFit;
Public property FillPatternForeColor: TXc12IndexColor read GetFillPatternForeColor write SetFillPatternForeColor;
Public property FillPatternForeColorRGB: TXc12RGBColor read GetFillPatternForeColorRGB write SetFillPatternForeColorRGB;
Public property FillPatternBackColor: TXc12IndexColor read GetFillPatternBackColor write SetFillPatternBackColor;
Public property FillPatternBackColorRGB: TXc12RGBColor read GetFillPatternBackColorRGB write SetFillPatternBackColorRGB;
Public property CellColorRGB: TXc12RGBColor read GetCellColorRGB write SetCellColorRGB;
Public property FillPatternPattern: TXc12FillPattern read GetFillPatternPattern write SetFillPatternPattern;
Public property NumberFormat: AxUCString read GetNumberFormat write SetNumberFormat;
Public property BorderTopColor: TXc12IndexColor read GetBorderTopColor write SetBorderTopColor;
Public property BorderTopColorRGB: TXc12RGBColor read GetBorderTopColorRGB write SetBorderTopColorRGB;
Public property BorderTopStyle: TXc12CellBorderStyle read GetBorderTopStyle write SetBorderTopStyle;
Public property BorderLeftColor: TXc12IndexColor read GetBorderLeftColor write SetBorderLeftColor;
Public property BorderLeftColorRGB: TXc12RGBColor read GetBorderLeftColorRGB write SetBorderLeftColorRGB;
Public property BorderLeftStyle: TXc12CellBorderStyle read GetBorderLeftStyle write SetBorderLeftStyle;
Public property BorderRightColor: TXc12IndexColor read GetBorderRightColor write SetBorderRightColor;
Public property BorderRightColorRGB: TXc12RGBColor read GetBorderRightColorRGB write SetBorderRightColorRGB;
Public property BorderRightStyle: TXc12CellBorderStyle read GetBorderRightStyle write SetBorderRightStyle;
Public property BorderBottomColor: TXc12IndexColor read GetBorderBottomColor write SetBorderBottomColor;
Public property BorderBottomColorRGB: TXc12RGBColor read GetBorderBottomColorRGB write SetBorderBottomColorRGB;
Public property BorderBottomStyle: TXc12CellBorderStyle read GetBorderBottomStyle write SetBorderBottomStyle;
Public property BorderDiagColor: TXc12IndexColor read GetBorderDiagColor write SetBorderDiagColor;
Public property BorderDiagColorRGB: TXc12RGBColor read GetBorderDiagColorRGB write SetBorderDiagColorRGB;
Public property BorderDiagStyle: TXc12CellBorderStyle read GetBorderDiagStyle write SetBorderDiagStyle;
Public property FontName: AxUCString read GetFontName write SetFontName;
Public property FontCharset: TFontCharset read GetFontCharset write SetFontCharset;
Public property FontFamily: integer read GetFontFamily write SetFontFamily;
Public property FontColor: TXc12RGBColor read GetFontColor write SetFontColor;
Public property FontSize: double read GetFontSize write SetFontSize;
Public property FontSize20: integer read GetFontSize20 write SetFontSize20;
Public property FontStyle: TXc12FontStyles read GetFontStyle write SetFontStyle;
Public property FontSubSuperScript: TXc12SubSuperscript read GetFontSubSuperScript write SetFontSubSuperScript;
Public property FontUnderline: TXc12Underline read GetFontUnderline write SetFontUnderline;

Description

Methods

Public constructor Create(AStyles: TXc12DataStyleSheet);
 
Public destructor Destroy; override;
 
Public procedure SetDefaultFormat;

Resets the format to default settings.

Public procedure CopyToTFont(Font: TFont);

Copies the font (TXFont) of the format to a TFont object. ˜param Font The TFont object to copy the properties to.

Public function IsFormatted: boolean;

Returns True if the object has formatting that differs from the default. ˜result True if the object is formatted.

Properties

Public property Protection: TXc12CellProtections read GetProtection write SetProtection;

Protection of cells.

Public property HorizAlignment: TXc12HorizAlignment read GetHorizAlignment write SetHorizAlignment;

Horizontal alignment of text in cells.

Public property VertAlignment: TXc12VertAlignment read GetVertAlignment write SetVertAlignment;

Vertical alignment of text in cells.

Public property Indent: integer read GetIndent write SetIndent;

Text indent The indent values can range from 0-15. A value of 0 (zero) is no indent. An increase with one increases the indent with about one character.

Public property Rotation: integer read GetRotation write SetRotation;

Rotation of cell text. Rotation, in degrees. ˜[br] The value 0 – 90 is rotation up 0 – 90 deg. The value 91 – 180 is rotation down 1 – 90 deg. The value 255 is vertical text.

Public property WrapText: boolean read GetWrapText write SetWrapText;
 
Public property ShrinkToFit: boolean read GetShrinkToFit write SetShrinkToFit;
 
Public property FillPatternForeColor: TXc12IndexColor read GetFillPatternForeColor write SetFillPatternForeColor;

The foreground fill color. Use this property to set the color of the foreground fill pattern. ˜[br] Note: This is the cell color. If you want to have just one color for the cell, use this property. ˜[br] ˜[link FillPatternBackColor] ˜[link FillPatternPattern]

Public property FillPatternForeColorRGB: TXc12RGBColor read GetFillPatternForeColorRGB write SetFillPatternForeColorRGB;
 
Public property FillPatternBackColor: TXc12IndexColor read GetFillPatternBackColor write SetFillPatternBackColor;

The background fill color. Use this property to set the color of the background fill pattern. ˜[br] Note: If no fill pattern is assigned to the format, this property has no effect. If you just want to set the cell color, use FillPatternForeColor. ˜[link FillPatternForeColor] ˜[link FillPatternPattern]

Public property FillPatternBackColorRGB: TXc12RGBColor read GetFillPatternBackColorRGB write SetFillPatternBackColorRGB;
 
Public property CellColorRGB: TXc12RGBColor read GetCellColorRGB write SetCellColorRGB;

The fill pattern for the cell. Use this property to set the fill pattern for the cell. Values can range between 0-127. 0 (zero) is no fill pattern. Fill patterns and there corresponding numbers, that are used in Excel:˜[br] ˜[image ..\help\PatternsNum.bmp] ˜[link FillPatternForeColor] ˜[link FillPatternBackColor]

Public property FillPatternPattern: TXc12FillPattern read GetFillPatternPattern write SetFillPatternPattern;
 
Public property NumberFormat: AxUCString read GetNumberFormat write SetNumberFormat;

Format mask used to format numbers. NumberFormat uses the same options as in the Format dilaog inExcel.˜[br] NumberFormat is also used to create cells with date and time values, as there are no specific date or time cells in Excel.

Public property BorderTopColor: TXc12IndexColor read GetBorderTopColor write SetBorderTopColor;

The color of the top cell border. ˜[link TXc12CellBorderStyle]

Public property BorderTopColorRGB: TXc12RGBColor read GetBorderTopColorRGB write SetBorderTopColorRGB;
 
Public property BorderTopStyle: TXc12CellBorderStyle read GetBorderTopStyle write SetBorderTopStyle;

The style of the top cell border.

Public property BorderLeftColor: TXc12IndexColor read GetBorderLeftColor write SetBorderLeftColor;

The color of the left cell border.

Public property BorderLeftColorRGB: TXc12RGBColor read GetBorderLeftColorRGB write SetBorderLeftColorRGB;
 
Public property BorderLeftStyle: TXc12CellBorderStyle read GetBorderLeftStyle write SetBorderLeftStyle;

The style of the left cell border.

Public property BorderRightColor: TXc12IndexColor read GetBorderRightColor write SetBorderRightColor;

The color of the right cell border.

Public property BorderRightColorRGB: TXc12RGBColor read GetBorderRightColorRGB write SetBorderRightColorRGB;
 
Public property BorderRightStyle: TXc12CellBorderStyle read GetBorderRightStyle write SetBorderRightStyle;

The style of the right cell border.

Public property BorderBottomColor: TXc12IndexColor read GetBorderBottomColor write SetBorderBottomColor;

The color of the bottom cell border.

Public property BorderBottomColorRGB: TXc12RGBColor read GetBorderBottomColorRGB write SetBorderBottomColorRGB;
 
Public property BorderBottomStyle: TXc12CellBorderStyle read GetBorderBottomStyle write SetBorderBottomStyle;

The style of the bottom cell border.

Public property BorderDiagColor: TXc12IndexColor read GetBorderDiagColor write SetBorderDiagColor;

The color of the lines in a cell with diagonal lines.

Public property BorderDiagColorRGB: TXc12RGBColor read GetBorderDiagColorRGB write SetBorderDiagColorRGB;
 
Public property BorderDiagStyle: TXc12CellBorderStyle read GetBorderDiagStyle write SetBorderDiagStyle;

The style of diagonal lines in a cell.

Public property FontName: AxUCString read GetFontName write SetFontName;

If the cell shall have diagonal lines.

The name of the font.

Public property FontCharset: TFontCharset read GetFontCharset write SetFontCharset;

The character set of the font.

Public property FontFamily: integer read GetFontFamily write SetFontFamily;

The family of the font. The FontFamily can have the following values: ˜[br] 0 = None (unknown/don't care). ˜[br] 1 = Roman. ˜[br] 2 = Swiss. ˜[br] 3 = Modern (fixed width). ˜[br] 4 = Script. ˜[br] 5 = Decorative. ˜[br]

Public property FontColor: TXc12RGBColor read GetFontColor write SetFontColor;

The color of the font.

Public property FontSize: double read GetFontSize write SetFontSize;

The size of the font in points. ˜[link FontSize20]

Public property FontSize20: integer read GetFontSize20 write SetFontSize20;

Size of the font in units of 1/20th of a point. ˜[link FontSize]

Public property FontStyle: TXc12FontStyles read GetFontStyle write SetFontStyle;

Font style.

Public property FontSubSuperScript: TXc12SubSuperscript read GetFontSubSuperScript write SetFontSubSuperScript;

Use FontSubSuperScript to set if the font shall be subscript or superscript.

Public property FontUnderline: TXc12Underline read GetFontUnderline write SetFontUnderline;

Underline style of the font.


Generated by PasDoc 0.12.1 on 2013-03-18 12:36:48